/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.mail.remote;

import javax.mail.*;
import com.sun.mail.mbox.*;

/**
 * A remote Inbox folder.  The data is actually managed by our subclass
 * (<code>MboxFolder</code>).  We fetch data from the remote Inbox and
 * add it to the local Inbox.
 *
 * @author Bill Shannon
 */

public class RemoteInbox extends MboxFolder {

    private RemoteStore mstore;

    protected RemoteInbox(RemoteStore store, String name) {
	super(store, name);
	this.mstore = store;
    }

    /**
     * Poll the remote store for any new messages.
     */
    public synchronized boolean hasNewMessages() {
	try {
	    mstore.updateInbox();
	} catch (MessagingException ex) {
	    // ignore it
	}
	return super.hasNewMessages();
    }

    /**
     * Open the folder in the specified mode.
     * Poll the remote store for any new messages first.
     */
    public synchronized void open(int mode) throws MessagingException {
	mstore.updateInbox();
	super.open(mode);
    }

    /**
     * Return the number of messages in this folder.
     * Poll the remote store for any new messages first.
     */
    public synchronized int getMessageCount() throws MessagingException {
	mstore.updateInbox();
	return super.getMessageCount();
    }
}
